Skip to content

docs: New record/artifact details/fields editing & field highlighting#1357

Open
validbeck wants to merge 29 commits into
mainfrom
beck/sc-16364/documentation-record-artifact-overview-new
Open

docs: New record/artifact details/fields editing & field highlighting#1357
validbeck wants to merge 29 commits into
mainfrom
beck/sc-16364/documentation-record-artifact-overview-new

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented May 27, 2026 •
edited
Loading

Pull Request Description

What and why?

sc-16364

How to test

Click on the live previews and review the major changes for accuracy:

Inventory

OLD NEW Change
Edit inventory fields Edit inventory fields Split page into two new sections: Edit fields on individual records (new guidance on editing fields in Overview tab, Inventory Fields tab, or the right sidebar); Edit fields in bulk for multiple records
Customize record overview page Customize record overview page New field management UX & highlighting instructions.
Configure record interdependencies Configure record interdependencies Updated instructions to use the Interdependencies tab; removed outdated screenshots and related image assets.

Workflows

OLD NEW Change
Manage workflows Manage workflows Updated "Review workflow histories" section to the Workflows tab. Note that the other sections still refer to "Active Workflows" deliberately, as this is less steps for users when dealing with workflows already running.

Validation

OLD NEW Change
Working with artifacts Working with artifacts Updated the listing tiles to replace Add and manage artifacts with Log artifacts and Update artifacts.
Add and manage artifacts Log artifacts Split artifact creation into a focused guide for logging/adding artifacts. No new info on this page.
Add and manage artifacts Update artifacts Split artifact management into a focused guide for editing (new guidance on editing fields in Overview tab, Artifact Fields tab, or the right sidebar), commenting, and resolving artifacts.
Customize artifact overview page Customize artifact overview page New field management UX & highlighting instructions.

What needs special review?

Important

I already ran the Cursor agent review a few times — it might tell you that the Workflows section is incomplete, please refer to the note above under "Manage workflows" for more info.

I also confirm that no docs change is required the new "Date Created" etc. new marker labels on record/artifact timeline view as it's just generally labelling covered by the Review workflow histories section.

Dependencies, breaking changes, and deployment notes

n/a

Release notes

Covered by https://github.com/validmind/frontend/pull/2514.

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@validbeck validbeck self-assigned this May 27, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label May 27, 2026
@validbeck validbeck changed the title Beck/sc 16364/documentation record artifact overview new docs: Redesigned record/artifact detail page/fields editing & field highlighting May 27, 2026
@validbeck validbeck changed the title docs: Redesigned record/artifact detail page/fields editing & field highlighting docs: New record/artifact details/fields editing & field highlighting May 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

PR Summary

This PR refactors the documentation and user interface instructions related to artifact management and workflows. The key changes include:

  • Renaming and redirecting artifact-related links from the old "Add and manage artifacts" pages to the new "Log artifacts" and "Update artifacts" pages. Files such as _add-artifacts-on-documentation.qmd, customize-artifact-overview-page.qmd, and various workflow and release notes references have been updated accordingly.
  • Updating URL references and sidebar configuration to replace deprecated pages with the new pages. For example, links in the FAQ, Quickstart, reporting section, and workflows documentation now point to the updated artifact pages.
  • UI instructions have been modified to direct users to click on the proper tabs (e.g., "Workflows" tab on record and artifact details pages) instead of previously referenced sections. This change aims to improve clarity and ensure consistency in the user experience.
  • Adjustments were made to the inventory customization and interdependencies guides. The removal of an unused reference file hints at a cleanup of redundant documentation.
  • Minor updates in CSS introduce new color classes (e.g., .teal and .grey) to support consistent styling for highlighted fields.
  • Overall, these changes are intended to streamline artifact logging and updating processes, ensuring that users access the correct documentation and can navigate the system intuitively.

Test Suggestions

  • Manually verify that all links in the updated documentation pages point to the correct new artifact management pages ('Log artifacts' and 'Update artifacts').
  • Check that the sidebar and navigation menus reflect the updated URLs and file names.
  • Test the workflow initiation and history views to ensure that clicking on the 'Workflows' tab displays the expected content.
  • Perform a UI walkthrough to confirm that inventory and artifact management instructions are clear and reflect the new steps.
  • Review the newly added CSS classes (.teal and .grey) for proper styling across different pages.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@validbeck validbeck requested a review from gtagle May 27, 2026 20:56
gtagle
gtagle approved these changes May 27, 2026
View reviewed changes
Copy link
Copy Markdown
Collaborator

@gtagle gtagle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instructions are clear, this is good to go

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gtagle gtagle gtagle approved these changes

Assignees

@validbeck validbeck

Labels

internal Not to be externalized in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@validbeck @gtagle